<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>BaseMacLayer</i></h2>
<b>Package:</b> org.mixim.base.modules<br/><b>File: <a href="base-modules-BaseMacLayer.ned.html">base/modules/BaseMacLayer.ned</a></b><br/><p><a href="../doxy/a00025.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Base module for every mac layer module</p>
<img src="org.mixim.base.modules.BaseMacLayer-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="org.mixim.base.modules.BaseMacLayer.html" title="BaseMacLayer" alt="BaseMacLayer" coords="0,0,138,40">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram. Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMacLayer-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseMacLayer.html" title="Simple Module BaseMacLayer" alt="" coords="5,6,115,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram. Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMacLayer-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseMacLayer.html" title="Simple Module BaseMacLayer" alt="" coords="280,83,389,111">
<area shape="rect" id="node4" href="org.mixim.modules.mac.BMacLayer.html" title="Simple Module BMacLayer" alt="" coords="5,161,93,189">
<area shape="rect" id="node6" href="org.mixim.modules.mac.csma.html" title="Simple Module csma" alt="" coords="117,161,189,189">
<area shape="rect" id="node8" href="org.mixim.modules.mac.CSMAMacLayer.html" title="Simple Module CSMAMacLayer" alt="" coords="213,161,331,189">
<area shape="rect" id="node10" href="org.mixim.modules.mac.LMacLayer.html" title="Simple Module LMacLayer" alt="" coords="355,161,440,189">
<area shape="rect" id="node12" href="org.mixim.modules.mac.Mac80211.html" title="Simple Module Mac80211" alt="" coords="464,161,547,189">
<area shape="rect" id="node14" href="org.mixim.modules.mac.UWBIRMac.html" title="Simple Module UWBIRMac" alt="" coords="571,161,664,189">
<area shape="rect" id="node2" href="org.mixim.base.modules.BaseLayer.html" title="Simple Module BaseLayer" alt="" coords="293,6,376,34">
</map>
<h3 class="subtitle">Extends:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.base.modules.BaseLayer.html">BaseLayer</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Base module for all layer modules. Defines the in and out gates</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Known subclasses:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.modules.mac.BMacLayer.html">BMacLayer</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Implementation of B-MAC (called also Berkeley MAC, Low Power Listening or 
LPL).
See C++ documentation for details.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mac.csma.html">csma</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Generic CSMA protocol supporting Mac-ACKs as well as
constant, linear or exponential backoff times.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mac.CSMAMacLayer.html">CSMAMacLayer</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>CSMA MAC protocol</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mac.LMacLayer.html">LMacLayer</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Implementation of L-MAC (Lightweight Medium Access Protocol for
Wireless Sensor Networks)</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mac.Mac80211.html">Mac80211</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Implementation of the 802.11b MAC protocol. This module is intended
to be used in combination with the Decider80211 as decider for the 
physical layer.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mac.UWBIRMac.html">UWBIRMac</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.
Just before sending down a packet to the UWBIRPhyLayer, call prepareData(<a href="UWBIRMacPkt.html">UWBIRMacPkt</a>* packet).
Just after receiving a packet from the UWBIRPhyLayer, call validatePacket(<a href="UWBIRMacPkt.html">UWBIRMacPkt</a>* packet)
and check the returned bool value to know if the packet could be decoded successfully.</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">notAffectedByHostState</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120">false</td>
   <td>
   </td>
</tr>
<tr class="local">
   <td width="150">coreDebug</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>debug switch</p>
   </td>
</tr>
<tr class="local">
   <td width="150">headerLength</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>length of the MAC packet header (in bits)</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
   </tr>
<tr>
   <td width="150">class</td>
   <td width="100"><i>BaseMacLayer</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Gates:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Direction</th>
      <th>Size</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">upperGateIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>from upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">upperGateOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>to uppe layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">upperControlIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>control from upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">upperControlOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>control to upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">lowerGateIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>from lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">lowerGateOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>to lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">lowerControlIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>control from lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">lowerControlOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>control to lower layer</p>
</td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">// Base module for every mac layer module
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseMacLayer</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">extends</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseLayer</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000000; font-weight: bold; ">@class</span><span style="color: #000000; ">(</span><span style="color: #000000; ">BaseMacLayer</span><span style="color: #000000; ">);
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">coreDebug</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// debug switch
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">headerLength</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">bit</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// length of the MAC packet header (in bits)
</span><span style="color: #000000; ">}

</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
